Replace CHANGELOG.markdown with GitHub Releases#143
Merged
Conversation
The markdown changelog was stale and duplicated what GitHub Releases already tracks better. This removes the file, points the gemspec changelog_uri to the releases page, and adds .github/release.yml for auto-categorized release notes on future releases.
joeybaer
approved these changes
May 22, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Closes #142
CHANGELOG.markdown(was missing 5.5.0–6.0.0, had wrong unreleased version)changelog_urito point to GitHub Releases pageCHANGELOG.markdownfromgem.files.github/release.ymlfor auto-categorized release notes (breaking, added, fixed, docs)Going forward
Use
gh release create vX.Y.Z --generate-noteswhen cutting releases — GitHub will auto-categorize merged PRs by label using the.github/release.ymlconfig.Test plan
gem build customerio.gemspecsucceeds without CHANGELOG.markdownNote
Low Risk
Low risk: documentation/release-process only changes that affect gem packaging metadata, not runtime code paths.
Overview
Moves changelog management from the repo to GitHub Releases by deleting
CHANGELOG.markdownand adding.github/release.ymlto auto-categorize generated release notes by PR labels.Updates
customerio.gemspecto stop shippingCHANGELOG.markdownin the gem and to pointchangelog_urimetadata at the GitHub Releases page instead of the removed file.Reviewed by Cursor Bugbot for commit 97b2971. Bugbot is set up for automated code reviews on this repo. Configure here.